<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>v_voip_framer: xframer_hw.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.gif"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">v_voip_framer
   </div>
   <div id="projectbrief">Xilinx SDK Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('xframer__hw_8h.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#define-members">Macros</a>  </div>
  <div class="headertitle">
<div class="title">xframer_hw.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
<div class="textblock"><p>This header file contains identifiers and register-level core functions (or macros) that can be used to access the Xilinx VoIP Framer core. </p>
<p>For more information about the operation of this core see the hardware specification and documentation in the higher level driver <a class="el" href="xframer_8h.html" title="This is the main header file for VoIP Framer core. ">xframer.h</a> file.</p>
<pre>
MODIFICATION HISTORY:</pre><pre>Ver   Who    Date     Changes
<hr/>

1.00   mmo   02/12/16 Initial release.</pre><pre></pre> </div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a44d4f6513d60c50a176675d2fbfde2d1"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xframer__hw_8h.html#a44d4f6513d60c50a176675d2fbfde2d1">XFRAMER_HW_H_</a></td></tr>
<tr class="memdesc:a44d4f6513d60c50a176675d2fbfde2d1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prevent circular inclusions by using protection macros.  <a href="#a44d4f6513d60c50a176675d2fbfde2d1">More...</a><br /></td></tr>
<tr class="separator:a44d4f6513d60c50a176675d2fbfde2d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader">Register access macro definition</div></td></tr>
<tr class="memitem:ad7e0311b40b4aaabc69a46d78dd844e1"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xframer__hw_8h.html#ad7e0311b40b4aaabc69a46d78dd844e1">XFramer_In32</a>&#160;&#160;&#160;Xil_In32</td></tr>
<tr class="memdesc:ad7e0311b40b4aaabc69a46d78dd844e1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Input Operations.  <a href="#ad7e0311b40b4aaabc69a46d78dd844e1">More...</a><br /></td></tr>
<tr class="separator:ad7e0311b40b4aaabc69a46d78dd844e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4df19f680401b30d5a74ceac681f4d9f"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xframer__hw_8h.html#a4df19f680401b30d5a74ceac681f4d9f">XFramer_Out32</a>&#160;&#160;&#160;Xil_Out32</td></tr>
<tr class="memdesc:a4df19f680401b30d5a74ceac681f4d9f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Output Operations.  <a href="#a4df19f680401b30d5a74ceac681f4d9f">More...</a><br /></td></tr>
<tr class="separator:a4df19f680401b30d5a74ceac681f4d9f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0eba32102023b9a314b5593964b8d88e"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xframer__hw_8h.html#a0eba32102023b9a314b5593964b8d88e">XFramer_ReadReg</a>(BaseAddress,  RegOffset)&#160;&#160;&#160;<a class="el" href="xframer__hw_8h.html#ad7e0311b40b4aaabc69a46d78dd844e1">XFramer_In32</a>((BaseAddress) + ((u32)RegOffset))</td></tr>
<tr class="memdesc:a0eba32102023b9a314b5593964b8d88e"><td class="mdescLeft">&#160;</td><td class="mdescRight">This macro reads a value from a VoIP Framer register.  <a href="#a0eba32102023b9a314b5593964b8d88e">More...</a><br /></td></tr>
<tr class="separator:a0eba32102023b9a314b5593964b8d88e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abafe3bb822eb431a30d1192df8447b2b"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xframer__hw_8h.html#abafe3bb822eb431a30d1192df8447b2b">XFramer_WriteReg</a>(BaseAddress,  RegOffset,  Data)&#160;&#160;&#160;<a class="el" href="xframer__hw_8h.html#a4df19f680401b30d5a74ceac681f4d9f">XFramer_Out32</a>((BaseAddress) + ((u32)RegOffset), (u32)(Data))</td></tr>
<tr class="memdesc:abafe3bb822eb431a30d1192df8447b2b"><td class="mdescLeft">&#160;</td><td class="mdescRight">This macro writes a value to a VoIP Framer register.  <a href="#abafe3bb822eb431a30d1192df8447b2b">More...</a><br /></td></tr>
<tr class="separator:abafe3bb822eb431a30d1192df8447b2b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="a44d4f6513d60c50a176675d2fbfde2d1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a44d4f6513d60c50a176675d2fbfde2d1">&#9670;&nbsp;</a></span>XFRAMER_HW_H_</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XFRAMER_HW_H_</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Prevent circular inclusions by using protection macros. </p>

</div>
</div>
<a id="ad7e0311b40b4aaabc69a46d78dd844e1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad7e0311b40b4aaabc69a46d78dd844e1">&#9670;&nbsp;</a></span>XFramer_In32</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XFramer_In32&#160;&#160;&#160;Xil_In32</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Input Operations. </p>

</div>
</div>
<a id="a4df19f680401b30d5a74ceac681f4d9f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4df19f680401b30d5a74ceac681f4d9f">&#9670;&nbsp;</a></span>XFramer_Out32</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XFramer_Out32&#160;&#160;&#160;Xil_Out32</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Output Operations. </p>

</div>
</div>
<a id="a0eba32102023b9a314b5593964b8d88e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0eba32102023b9a314b5593964b8d88e">&#9670;&nbsp;</a></span>XFramer_ReadReg</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XFramer_ReadReg</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">BaseAddress, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">RegOffset&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td>&#160;&#160;&#160;<a class="el" href="xframer__hw_8h.html#ad7e0311b40b4aaabc69a46d78dd844e1">XFramer_In32</a>((BaseAddress) + ((u32)RegOffset))</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This macro reads a value from a VoIP Framer register. </p>
<p>A 32 bit read is performed. If the component is implemented in a smaller width, only the least significant data is read from the register. The most significant data will be read as 0.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">BaseAddress</td><td>is the base address of the VoIP Framer core instance. </td></tr>
    <tr><td class="paramname">RegOffset</td><td>is the register offset of the register (defined at the top of this file).</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The 32-bit value of the register.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>C-style signature: u32 <a class="el" href="xframer__hw_8h.html#a0eba32102023b9a314b5593964b8d88e" title="This macro reads a value from a VoIP Framer register. ">XFramer_ReadReg(u32 BaseAddress, u32 RegOffset)</a> </dd></dl>

<p class="reference">Referenced by <a class="el" href="xframer_8h.html#ac297d2bb05b8223e943e53988cc6d149">XFramer_ChannelUpdate()</a>, <a class="el" href="xframer_8h.html#ae240a50d845e83cf86b06bc238f4f602">XFramer_ChStatus()</a>, <a class="el" href="xframer_8h.html#accda8c5474500d6ef1330aa8803dbc22">XFramer_CoreInfo()</a>, <a class="el" href="xframer_8h.html#abbff44559195d5a58bfb21238c5e9d5a">XFramer_EthDestAddr1()</a>, <a class="el" href="xframer_8h.html#a98aea3b73e6afb146dddf3e2e5c69305">XFramer_FECTOS()</a>, <a class="el" href="xframer_8h.html#a91da7b9e5f7b32a678fdd1db7e5312fd">XFramer_FECTTL()</a>, <a class="el" href="xframer_8h.html#ab9a6a51809f3695599dc2de8b320db68">XFramer_GetDropPcktCnt()</a>, <a class="el" href="xframer_8h.html#aecff75034c9dc2d4536386229d5c7c23">XFramer_GetEthSrcAddr0()</a>, <a class="el" href="xframer_8h.html#ad9ce219cfa32b0a9a00cd55c68065162">XFramer_GetEthSrcAddr1()</a>, <a class="el" href="xframer_8h.html#a84da8b323c4e01b64e75aab6441a05da">XFramer_GetPeakBufferLevel()</a>, <a class="el" href="xframer_8h.html#a1d69b4c8cc74fa553cf800ffe00ec3e3">XFramer_GetRXPcktCnt()</a>, <a class="el" href="xframer_8h.html#ae705265bfe690af89d69419118a9236c">XFramer_GetTransmitEnable()</a>, <a class="el" href="xframer_8h.html#a879bf7d43faf2dd936d2633b0bc7d486">XFramer_GetTXPcktCnt()</a>, <a class="el" href="xframer_8h.html#a7bd914b11eb7c0e7709d34f48a1c8e51">XFramer_MediaTOS()</a>, <a class="el" href="xframer_8h.html#a1755eceed56ae0c4e235800148ec3fb9">XFramer_MediaTTL()</a>, <a class="el" href="xframer_8h.html#a716dd945dbe92cdf0bce3c6bac35d2eb">XFramer_SetVLAN()</a>, <a class="el" href="xframer_8h.html#aa5397e1f41e72df0987c0b28d3c7117e">XFramer_SoftReset()</a>, <a class="el" href="xframer_8h.html#a34574f9eeef0cd125c4347574f9d343a">XFramer_UDPDest()</a>, <a class="el" href="xframer_8h.html#abe1042eace723c1702fcb02ce0ca07ce">XFramer_UDPSrc()</a>, and <a class="el" href="xframer_8h.html#a268fd6e2b253de8d187270c877a6543e">XFramer_VLANID()</a>.</p>

</div>
</div>
<a id="abafe3bb822eb431a30d1192df8447b2b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abafe3bb822eb431a30d1192df8447b2b">&#9670;&nbsp;</a></span>XFramer_WriteReg</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XFramer_WriteReg</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">BaseAddress, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">RegOffset, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">Data&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td>&#160;&#160;&#160;<a class="el" href="xframer__hw_8h.html#a4df19f680401b30d5a74ceac681f4d9f">XFramer_Out32</a>((BaseAddress) + ((u32)RegOffset), (u32)(Data))</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This macro writes a value to a VoIP Framer register. </p>
<p>A 32 bit write is performed. If the component is implemented in a smaller width, only the least significant data is written.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">BaseAddress</td><td>is the base address of the VoIP Framer core instance. </td></tr>
    <tr><td class="paramname">RegOffset</td><td>is the register offset of the register (defined at the top of this file) to be written. </td></tr>
    <tr><td class="paramname">Data</td><td>is the 32-bit value to write into the register.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>C-style signature: void <a class="el" href="xframer__hw_8h.html#abafe3bb822eb431a30d1192df8447b2b" title="This macro writes a value to a VoIP Framer register. ">XFramer_WriteReg(u32 BaseAddress, u32 RegOffset, u32 Data)</a> </dd></dl>

<p class="reference">Referenced by <a class="el" href="xframer_8h.html#aa6ef8ec5049830215f10f450e8b91580">XFramer_ChannelAccess()</a>, <a class="el" href="xframer_8h.html#a3116aed7708b386047f6d90f189e33ae">XFramer_ClearDropPcktCnt()</a>, <a class="el" href="xframer_8h.html#ae21f373e9204a25c267b7753ef3aa7a5">XFramer_ClearPeakBufferLevel()</a>, <a class="el" href="xframer_8h.html#a341f430ebd303c8042fd2d47c1a4c901">XFramer_ClearRXPcktCnt()</a>, <a class="el" href="xframer_8h.html#ac87bf36dcc5af44654b632b611b10038">XFramer_ClearTXPcktCnt()</a>, <a class="el" href="xframer_8h.html#a806708bae65853e02861bc122709b342">XFramer_EthDestAddr0()</a>, <a class="el" href="xframer_8h.html#a3f99403fb4bf0d9cf0bc31c62cf112a4">XFramer_EthSrcAddr0()</a>, <a class="el" href="xframer_8h.html#ae1b4f0e34af2a276bdb443abe460eea3">XFramer_EthSrcAddr1()</a>, <a class="el" href="xframer_8h.html#a8b6240b876fc403d2d23dcde6c6977bc">XFramer_IP0Dest()</a>, <a class="el" href="xframer_8h.html#a0457387122a5370d47220c26a32e534d">XFramer_IP0Src()</a>, and <a class="el" href="xframer_8h.html#ae0b5a6c03d693fdfc5a899f81eddb893">XFramer_TransmitEnable()</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="footer">Copyright &copy; 2015 Xilinx Inc. All rights reserved.</li>
  </ul>
</div>
</body>
</html>
